DOC: Capture recent CI lessons in Documentation/AI/ skill files#6040
Merged
hjmjohnson merged 2 commits intoInsightSoftwareConsortium:mainfrom Apr 16, 2026
Merged
Conversation
github-actions
bot
added
type:Documentation
This comment was marked as resolved.
This comment was marked as resolved.
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
hjmjohnson
force-pushed
the
doc-ai-skill-updates-clean
branch
5 times, most recently
from
968d8ee to
9e9d8d5
Compare
This comment was marked as off-topic.
This comment was marked as off-topic.
This comment was marked as off-topic.
This comment was marked as off-topic.
This comment was marked as off-topic.
This comment was marked as off-topic.
This comment was marked as off-topic.
This comment was marked as off-topic.
hjmjohnson
force-pushed
the
doc-ai-skill-updates-clean
branch
3 times, most recently
from
12eedae to
c2ea712
Compare
hjmjohnson
force-pushed
the
doc-ai-skill-updates-clean
branch
from
c2ea712 to
bab0248
Compare
Member
Author
|
@blowekamp @N-Dekker @thewtex @dzenanz I think these are in a reasonable state to consider now. After these updates, Greptile will be able to better enforce the "historical community perspectives" as represented by these rules extracted from various commit, PR-comment, and discourse comments. |
N-Dekker
reviewed
Apr 14, 2026
hjmjohnson
force-pushed
the
doc-ai-skill-updates-clean
branch
from
bab0248 to
cb73c5a
Compare
thewtex
reviewed
Apr 14, 2026
hjmjohnson
force-pushed
the
doc-ai-skill-updates-clean
branch
2 times, most recently
from
0a91cb6 to
d6c9dc0
Compare
hjmjohnson
force-pushed
the
doc-ai-skill-updates-clean
branch
2 times, most recently
from
1aea1f9 to
a7ea626
Compare
…ion/AI/ Add and expand AI agent guidance files based on lessons from recent PRs (ccache fixes, compiler flag removal, backports, attribution policy): - attribution.md: commit/PR attribution rules for AI-assisted work - code-review-lessons.md: patterns from 50+ reviewed PRs - compiler-cautions.md: new sections on unused-variable warnings, declare-then-assign pitfalls, refactoring checklist - conventions.md: ITK class/CMake/wrapping conventions - enforced-code-style.md: renamed from style.md, expanded - git-commits.md: hook enforcement, pre-commit checklist, deduplication with attribution.md (now cross-references instead of duplicating) - pull-requests.md: AI disclosure requirements - testing.md: targeted ctest patterns - AGENTS.md: updated routing table for new/renamed files
…community feedback Incorporate feedback from N-Dekker, blowekamp, and dzenanz: - Remove Tool-Assisted: and Assisted-by: trailers from commit guidance — AI disclosure moves entirely to the PR description inside <details> blocks (blowekamp's position) - Change Co-Authored-By: for AI from "never" to "discouraged" with rationale, acknowledging the open question (N-Dekker's GitHub-linking-semantics argument) - Distinguish reviewer Co-Authored-By: (design-shaping feedback) from review acknowledgment (prose mention) per N-Dekker's reviewer-vs-coauthor distinction - Strengthen brevity guidance: PR descriptions use collapsed <details> sections by default, keeping only 1-3 line summary visible (dzenanz's conciseness feedback) - Make PR description the primary and sole mechanism for AI disclosure, with commit messages containing no AI attribution Closes InsightSoftwareConsortium#6055
hjmjohnson
force-pushed
the
doc-ai-skill-updates-clean
branch
from
a7ea626 to
5626cc7
Compare
This comment was marked as off-topic.
This comment was marked as off-topic.
Member
Author
|
@N-Dekker Thank you for the feedback. Your requested fixes are not reflected in te PR. See: https://github.com/InsightSoftwareConsortium/ITK/compare/a7ea62650b8ab7b8606403cd9dbec590ff477181..5626cc7bdc2c9f8701e6b27f0bc5d2b41e2d2f5f |
Member
Author
|
@dzenanz , @blowekamp , @thewtex, @N-Dekker, @hjmjohnson, I think this has addressed all the issues and improvements requested. THANK YOU all for commenting, expanding the scope, revising, and refining the language in these documents that capture the common failure modes and pain points for reviewers. Greptile can provide more automated feedback before human reviewers need to intervene. Currently, Greptile only runs on non-draft PR's, but I think it would help identify failure modes in drafts early in the review cycle so that they may be fixed before needing community responses. |
thewtex
approved these changes
Apr 16, 2026
Member
thewtex
left a comment
thewtex
left a comment
There was a problem hiding this comment.
👍 thanks for working on this, Hans!
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Update Documentation/AI/ skill files with CI lessons learned and revised attribution rules based on community feedback. Closes #6055.
Commit 1: CI lessons and code-review patterns
git-commits.md,style.md— dropWIP:prefix, addBUILD:, document[WIP]PR-title workflowcompiler-cautions.md— KWStyleenum classpitfall (§12), NumericTraits float range (§13)testing.md— GTest exception macros (ITK_TRY_EXPECT_EXCEPTION incompatible with GoogleTest)attribution.md— initial attribution rulescode-review-lessons.md— new file capturing recurring review patternsCommit 2: Revise attribution rules per #6055 feedback
Incorporates feedback from N-Dekker (#6055 comment), blowekamp (Discourse #7728 post #16), and dzenanz (#6055 comment):
Tool-Assisted:andAssisted-by:trailers removed. AI disclosure moves entirely to PR description inside<details>blocks.Co-Authored-By:only for design-shaping feedback, not routine review. Per N-Dekker: "A reviewer may not completely agree with the PR... A co-author usually does."<details>blocks. Per dzenanz: "commit messages and PR body should be concise."